<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>VMS::DCLsym - Perl extension to manipulate DCL symbols - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/VMS::DCLsym">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./VMS::DCLsym.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/VMS::DCLsym">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/VMS::DCLsym">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/VMS::DCLsym">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/VMS::DCLsym">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/VMS::DCLsym">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/VMS::DCLsym">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/VMS::DCLsym">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/VMS::DCLsym">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/VMS::DCLsym">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/VMS::DCLsym">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/VMS::DCLsym">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/VMS::DCLsym">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/VMS::DCLsym">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/VMS::DCLsym">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/VMS::DCLsym">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/VMS::DCLsym">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/VMS::DCLsym">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/VMS::DCLsym">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/VMS::DCLsym">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/VMS::DCLsym">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/VMS::DCLsym">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/VMS::DCLsym">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/VMS::DCLsym">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/VMS::DCLsym">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/VMS::DCLsym">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/VMS::DCLsym">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/VMS::DCLsym">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/VMS::DCLsym">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/VMS::DCLsym">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/VMS::DCLsym">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/VMS::DCLsym">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/VMS::DCLsym">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/VMS::DCLsym">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/VMS::DCLsym">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/VMS::DCLsym">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/VMS::DCLsym">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/VMS::DCLsym">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/VMS::DCLsym">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/VMS::DCLsym">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/VMS::DCLsym">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/VMS::DCLsym">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/VMS::DCLsym">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/VMS::DCLsym">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/VMS::DCLsym">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/VMS::DCLsym">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/VMS::DCLsym">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/VMS::DCLsym">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/VMS::DCLsym">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/VMS::DCLsym">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/VMS::DCLsym">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/VMS::DCLsym">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/VMS::DCLsym">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/VMS::DCLsym">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/VMS::DCLsym">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/VMS::DCLsym">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/VMS::DCLsym">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/VMS::DCLsym">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/VMS::DCLsym">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/VMS::DCLsym">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/VMS::DCLsym">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/VMS::DCLsym">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/VMS::DCLsym">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/VMS::DCLsym">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/VMS::DCLsym">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/VMS::DCLsym">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/VMS::DCLsym">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/VMS::DCLsym">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/VMS::DCLsym">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/VMS::DCLsym">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/VMS::DCLsym">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/VMS::DCLsym">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/VMS::DCLsym">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/VMS::DCLsym">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/VMS::DCLsym">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/VMS::DCLsym">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/VMS::DCLsym">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/VMS::DCLsym">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/VMS::DCLsym">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/VMS::DCLsym">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/VMS::DCLsym">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./VMS::DCLsym.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/VMS::DCLsym">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/VMS::DCLsym">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/VMS::DCLsym">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/VMS::DCLsym">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/VMS::DCLsym">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/VMS::DCLsym">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/VMS::DCLsym">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/VMS::DCLsym">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/VMS::DCLsym">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/VMS::DCLsym">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/VMS::DCLsym">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/VMS::DCLsym">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/VMS::DCLsym">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/VMS::DCLsym">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/VMS::DCLsym">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/VMS::DCLsym">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/VMS::DCLsym">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/VMS::DCLsym">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/VMS::DCLsym">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/VMS::DCLsym">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/VMS::DCLsym">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/VMS::DCLsym">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/VMS::DCLsym">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/VMS::DCLsym">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/VMS::DCLsym">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/VMS::DCLsym">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/VMS::DCLsym">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/VMS::DCLsym">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/VMS::DCLsym">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/VMS::DCLsym">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/VMS::DCLsym">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/VMS::DCLsym">5.35.1</a>
          <a class="dropdown-item active" href="./VMS::DCLsym.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./VMS::DCLsym.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./VMS::DCLsym.html">VMS::DCLsym</a>
          <div id="more">
            (<a href="./VMS::DCLsym.txt">source</a>,
            <a href="https://metacpan.org/pod/VMS::DCLsym">CPAN</a>)
          </div>
            <div id="moduleversion">version 1.09</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#DESCRIPTION">DESCRIPTION</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#Tied-hash-interface">Tied hash interface</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#Object-interface">Object interface</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#AUTHOR">AUTHOR</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#VERSION">VERSION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./VMS::DCLsym.html#BUGS">BUGS</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./VMS::DCLsym.html#NAME">#</a>NAME</h1>

<p>VMS::DCLsym - Perl extension to manipulate DCL symbols</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./VMS::DCLsym.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>tie %allsyms, VMS::DCLsym;
tie %cgisyms, VMS::DCLsym, &#39;GLOBAL&#39;;


$handle = new VMS::DCLsym;
$value = $handle-&gt;getsym($name);
$handle-&gt;setsym($name, $value, &#39;GLOBAL&#39;)
    or die &quot;Can&#39;t create symbol: $!\n&quot;;
$handle-&gt;delsym($name, &#39;LOCAL&#39;) or die &quot;Can&#39;t delete symbol: $!\n&quot;;
$handle-&gt;clearcache();</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="./VMS::DCLsym.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>The VMS::DCLsym extension provides access to DCL symbols using a tied hash interface. This allows Perl scripts to manipulate symbols in a manner similar to the way in which logical names are manipulated via the built-in <code>%ENV</code> hash. Alternatively, one can call methods in this package directly to read, create, and delete symbols.</p>

<h2 id="Tied-hash-interface"><a class="permalink" href="./VMS::DCLsym.html#Tied-hash-interface">#</a><a id="Tied"></a>Tied hash interface</h2>

<p>This interface lets you treat the DCL symbol table as a Perl associative array, in which the key of each element is the symbol name, and the value of the element is that symbol&#39;s value. Case is not significant in the key string, as DCL converts symbol names to uppercase, but it is significant in the value string. All of the usual operations on associative arrays are supported. Reading an element retrieves the current value of the symbol, assigning to it defines a new symbol (or overwrites the old value of an existing symbol), and deleting an element deletes the corresponding symbol. Setting an element to <code>undef</code>, or <code>undef</code>ing it directly, sets the corresponding symbol to the null string. You may also read the special keys &#39;:GLOBAL&#39; and &#39;:LOCAL&#39; to find out whether a default symbol table has been specified for this hash (see the next paragraph), or set either or these keys to specify a default symbol table.</p>

<p>When you call the <code>tie</code> function to bind an associative array to this package, you may specify as an optional argument the symbol table in which you wish to create and delete symbols. If the argument is the string &#39;GLOBAL&#39;, then the global symbol table is used; any other string causes the local symbol table to be used. Note that this argument does not affect attempts to read symbols; if a symbol with the specified name exists in the local symbol table, it is always returned in preference to a symbol by the same name in the global symbol table.</p>

<h2 id="Object-interface"><a class="permalink" href="./VMS::DCLsym.html#Object-interface">#</a><a id="Object"></a>Object interface</h2>

<p>Although it&#39;s less convenient in some ways than the tied hash interface, you can also call methods directly to manipulate individual symbols. In some cases, this allows you finer control than using a tied hash aggregate. The following methods are supported:</p>

<dl>

<dt id="new"><a class="permalink" href="./VMS::DCLsym.html#new">#</a>new</dt>
<dd>

<p>This creates a <code>VMS::DCLsym</code> object which can be used as a handle for later method calls. The single optional argument specifies the symbol table used by default in future method calls, in the same way as the optional argument to <code>tie</code> described above.</p>

</dd>
<dt id="getsym"><a class="permalink" href="./VMS::DCLsym.html#getsym">#</a>getsym</dt>
<dd>

<p>If called in a scalar context, <code>getsym</code> returns the value of the symbol whose name is given as the argument to the call, or <code>undef</code> if no such symbol exists. Symbols in the local symbol table are always used in preference to symbols in the global symbol table. If called in a list context, <code>getsym</code> returns a two-element list, whose first element is the value of the symbol, and whose second element is the string &#39;GLOBAL&#39; or &#39;LOCAL&#39;, indicating the table from which the symbol&#39;s value was read.</p>

</dd>
<dt id="setsym"><a class="permalink" href="./VMS::DCLsym.html#setsym">#</a>setsym</dt>
<dd>

<p>The first two arguments taken by this method are the name of the symbol and the value which should be assigned to it. The optional third argument is a string specifying the symbol table to be used; &#39;GLOBAL&#39; specifies the global symbol table, and any other string specifies the local symbol table. If this argument is omitted, the default symbol table for the object is used. <code>setsym</code> returns TRUE if successful, and FALSE otherwise.</p>

</dd>
<dt id="delsym"><a class="permalink" href="./VMS::DCLsym.html#delsym">#</a>delsym</dt>
<dd>

<p>This method deletes the symbol whose name is given as the first argument. The optional second argument specifies the symbol table, as described above under <code>setsym</code>. It returns TRUE if the symbol was successfully deleted, and FALSE if it was not.</p>

</dd>
<dt id="clearcache"><a class="permalink" href="./VMS::DCLsym.html#clearcache">#</a>clearcache</dt>
<dd>

<p>Because of the overhead associated with obtaining the list of defined symbols for the tied hash iterator, it is only done once, and the list is reused for subsequent iterations. Changes to symbols made through this package are recorded, but in the rare event that someone changes the process&#39; symbol table from outside (as is possible using some software from the net), the iterator will be out of sync with the symbol table. If you expect this to happen, you can reset the cache by calling this method. In addition, if you pass a FALSE value as the first argument, caching will be disabled. It can be re-enabled later by calling <code>clearcache</code> again with a TRUE value as the first argument. It returns TRUE or FALSE to indicate whether caching was previously enabled or disabled, respectively.</p>

<p>This method is a stopgap until we can incorporate code into this extension to traverse the process&#39; symbol table directly, so it may disappear in a future version of this package.</p>

</dd>
</dl>

<h1 id="AUTHOR"><a class="permalink" href="./VMS::DCLsym.html#AUTHOR">#</a>AUTHOR</h1>

<p>Charles Bailey bailey@newman.upenn.edu</p>

<h1 id="VERSION"><a class="permalink" href="./VMS::DCLsym.html#VERSION">#</a>VERSION</h1>

<p>1.09</p>

<h1 id="BUGS"><a class="permalink" href="./VMS::DCLsym.html#BUGS">#</a>BUGS</h1>

<p>The list of symbols for the iterator is assembled by spawning off a subprocess, which can be slow. Ideally, we should just traverse the process&#39; symbol table directly from C.</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
